/*
# Copyright (c) 2015-2016, NVIDIA CORPORATION. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#  * Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#  * Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#  * Neither the name of NVIDIA CORPORATION nor the names of its
#    contributors may be used to endorse or promote products derived
#    from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#ifndef NVXIO_SYNCTIMER_HPP
#define NVXIO_SYNCTIMER_HPP

#include <memory>

#include <NVX/Export.hpp>

/**
 * \file
 * \brief The `SyncTimer` interface and factory.
 */

/**
 * \defgroup group_nvxio_sync_timer Synchronization Timer
 * \brief Defines a synchronization timer.
 * \ingroup nvx_nvxio_api
 */

namespace nvxio {

/**
 * \brief A timer that ticks at a constant frequency and can be synchronized with.
 * \ingroup group_nvxio_sync_timer
 */
class NVXIO_EXPORT SyncTimer
{
public:
    virtual ~SyncTimer(){}

    /**
     * \brief Starts the timer's ticking.
     * \param [in] periodSeconds The time between ticks, in seconds.
     */
    virtual void arm(double periodSeconds) = 0;

    /**
     * \brief Waits until the timer's next unwaited-for tick.
     *
     * If the timer has ticked at least once since the last call to \ref synchronize,
     * it returns immediately. Otherwise, it waits until the next tick.
     */
    virtual void synchronize() = 0;
};

/**
 * \brief Creates a new synchronization timer.
 * \ingroup group_nvxio_sync_timer
 *
 * The timer is initially not ticking.
 */
NVXIO_EXPORT std::unique_ptr<SyncTimer> createSyncTimer();

}

#endif
